GetProperty {Link Object}

GetProperty

Syntax

SapObject.SapModel.LinkObj.GetProperty

VB6 Procedure

Function GetProperty(ByVal Name As String, ByRef PropName As String) As Long

Parameters

Name

The name of a defined link object.

PropName

The name of the link property assigned to the link object.

Remarks

This function retrieves the link property assigned to a link object.

The function returns zero if the property is successfully retrieved; otherwise it returns a nonzero value.

VBA Example

Sub GetLinkObjectProp()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Name As String

Dim PropName As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'add link object by points

ret = SapModel.LinkObj.AddByPoint("1", "5", Name)

'get link property

ret = SapModel.LinkObj.GetProperty(Name, PropName)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also

SetProperty

GetPropertyFD

SetPropertyFD